Най-добрите практики

Ето някои най-добрите практики, които ще ви помогнат при подреждането на вашия код, така че той да работи добре с другите WordPress плъгини и ядрото на WordPress.

Представки

Всички файлове, променливи и функции трябва да започват с уникален идентификатор. Представките защитават другите плъгини от презаписване на вашите променливи и стойности или случайно извикване на ваша функция. Представките също така ще ви защитят от същото. Добавянето на инициалите на името на плъгин ви или вашето име е едно добро начало.

Ето няколко примера за използване на префикси в код.

<?php

if ( !function_exists('myplugin_init' ) ) {

function myplugin_init() {

register_setting( 'myplugin_setting_example', 'foo' );

register_setting( 'myplugin_setting_demo', 'bar' );

}

if ( !function_exists( 'myplugin_get_demo_setting' ) ) {

function myplugin_get_demo_setting() {

return get_option( 'myplugin_setting' );

}

/* File path: settings/myplugin_example.php */

Организация на файл

Основната директория във вашия плъгин трябва да съдържа вашия plugin-name.php файл и, евентуално, файл за деинсталиране. Всички други файлове трябва да бъдат организирани в папки, когато е възможно.

Също така е полезно е да се раздели администраторсия код, и използвайте условно is_admin за да го предпазите от натоварване, когато не е необходимо. Например, в основния си плъгин файл може да се наложи следното:

<?php

if ( is_admin() ) {

// We are in admin mode

require_once( dirname(__file__).'/admin/myplugin_admin.php' );

}

?>

Структура на папката

Ясната структура на папката помага на вас и на другите работещи върху плъгина.

Дръжте подобни файлове заедно. Например, поставете JavaScript файлове в / JS папка, стилове в / CSS папка и изображения в / изображения папка.

Ето за справка:

/my-plugin-name
     my-plugin-name.php
     uninstall.php
     /admin
     /js
     /css
     /images
     /includes
     /settings

2016-02-12